<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="networkmanagement_v1.html">Network Management API</a> . <a href="networkmanagement_v1.projects.html">projects</a> . <a href="networkmanagement_v1.projects.locations.html">locations</a> . <a href="networkmanagement_v1.projects.locations.vpcFlowLogsConfigs.html">vpcFlowLogsConfigs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, vpcFlowLogsConfigId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with `state=DISABLED` will fail 2. The following fields are not considered as settings for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: * name * create_time * update_time * labels * description</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a specific `VpcFlowLogsConfig`.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the details of a specific `VpcFlowLogsConfig`.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all `VpcFlowLogsConfigs` in a given project.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Updating a configuration with `state=DISABLED` will fail. 2. The following fields are not considered as settings for the purpose of the check mentioned above, therefore - updating another configuration with the same fields but different values for the following fields will fail as well: * name * create_time * update_time * labels * description</p>
<p class="toc_element">
  <code><a href="#queryOrgVpcFlowLogsConfigs">queryOrgVpcFlowLogsConfigs(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">QueryOrgVpcFlowLogsConfigs returns a list of all organization-level VPC Flow Logs configurations applicable to the specified project.</p>
<p class="toc_element">
  <code><a href="#queryOrgVpcFlowLogsConfigs_next">queryOrgVpcFlowLogsConfigs_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#showEffectiveFlowLogsConfigs">showEffectiveFlowLogsConfigs(parent, filter=None, pageSize=None, pageToken=None, resource=None, x__xgafv=None)</a></code></p>
<p class="firstline">ShowEffectiveFlowLogsConfigs returns a list of all VPC Flow Logs configurations applicable to a specified resource.</p>
<p class="toc_element">
  <code><a href="#showEffectiveFlowLogsConfigs_next">showEffectiveFlowLogsConfigs_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, vpcFlowLogsConfigId=None, x__xgafv=None)</code>
  <pre>Creates a new `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with `state=DISABLED` will fail 2. The following fields are not considered as settings for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: * name * create_time * update_time * labels * description

Args:
  parent: string, Required. The parent resource of the VpcFlowLogsConfig to create, in one of the following formats: - For project-level resources: `projects/{project_id}/locations/global` - For organization-level resources: `organizations/{organization_id}/locations/global` (required)
  body: object, The request body.
    The object takes the form of:

{ # A configuration to generate VPC Flow Logs.
  &quot;aggregationInterval&quot;: &quot;A String&quot;, # Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the config was created.
  &quot;crossProjectMetadata&quot;: &quot;A String&quot;, # Optional. Determines whether to include cross project annotations in the logs. This field is available only for organization configurations. If not specified in org configs will be set to CROSS_PROJECT_METADATA_ENABLED.
  &quot;description&quot;: &quot;A String&quot;, # Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.
  &quot;filterExpr&quot;: &quot;A String&quot;, # Optional. Export filter used to define which VPC Flow Logs should be logged.
  &quot;flowSampling&quot;: 3.14, # Optional. The value of the field must be in (0, 1]. The sampling rate of VPC Flow Logs where 1.0 means all collected logs are reported. Setting the sampling rate to 0.0 is not allowed. If you want to disable VPC Flow Logs, use the state field instead. Default value is 1.0.
  &quot;interconnectAttachment&quot;: &quot;A String&quot;, # Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/regions/{region}/interconnectAttachments/{name}
  &quot;labels&quot;: { # Optional. Resource labels to represent user-provided metadata.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;metadata&quot;: &quot;A String&quot;, # Optional. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default value is INCLUDE_ALL_METADATA.
  &quot;metadataFields&quot;: [ # Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if &quot;metadata&quot; was set to CUSTOM_METADATA.
    &quot;A String&quot;,
  ],
  &quot;name&quot;: &quot;A String&quot;, # Identifier. Unique name of the configuration. The name can have one of the following forms: - For project-level configurations: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` - For organization-level configurations: `organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`
  &quot;network&quot;: &quot;A String&quot;, # Traffic will be logged from VMs, VPN tunnels and Interconnect Attachments within the network. Format: projects/{project_id}/global/networks/{name}
  &quot;state&quot;: &quot;A String&quot;, # Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Setting state=DISABLED will pause the log generation for this config.
  &quot;subnet&quot;: &quot;A String&quot;, # Traffic will be logged from VMs within the subnetwork. Format: projects/{project_id}/regions/{region}/subnetworks/{name}
  &quot;targetResourceState&quot;: &quot;A String&quot;, # Output only. Describes the state of the configured target resource for diagnostic purposes.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the config was updated.
  &quot;vpnTunnel&quot;: &quot;A String&quot;, # Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name}
}

  vpcFlowLogsConfigId: string, Required. ID of the `VpcFlowLogsConfig`.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes a specific `VpcFlowLogsConfig`.

Args:
  name: string, Required. The resource name of the VpcFlowLogsConfig, in one of the following formats: - For a project-level resource: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` - For an organization-level resource: `organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets the details of a specific `VpcFlowLogsConfig`.

Args:
  name: string, Required. The resource name of the VpcFlowLogsConfig, in one of the following formats: - For project-level resources: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` - For organization-level resources: `organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A configuration to generate VPC Flow Logs.
  &quot;aggregationInterval&quot;: &quot;A String&quot;, # Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the config was created.
  &quot;crossProjectMetadata&quot;: &quot;A String&quot;, # Optional. Determines whether to include cross project annotations in the logs. This field is available only for organization configurations. If not specified in org configs will be set to CROSS_PROJECT_METADATA_ENABLED.
  &quot;description&quot;: &quot;A String&quot;, # Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.
  &quot;filterExpr&quot;: &quot;A String&quot;, # Optional. Export filter used to define which VPC Flow Logs should be logged.
  &quot;flowSampling&quot;: 3.14, # Optional. The value of the field must be in (0, 1]. The sampling rate of VPC Flow Logs where 1.0 means all collected logs are reported. Setting the sampling rate to 0.0 is not allowed. If you want to disable VPC Flow Logs, use the state field instead. Default value is 1.0.
  &quot;interconnectAttachment&quot;: &quot;A String&quot;, # Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/regions/{region}/interconnectAttachments/{name}
  &quot;labels&quot;: { # Optional. Resource labels to represent user-provided metadata.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;metadata&quot;: &quot;A String&quot;, # Optional. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default value is INCLUDE_ALL_METADATA.
  &quot;metadataFields&quot;: [ # Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if &quot;metadata&quot; was set to CUSTOM_METADATA.
    &quot;A String&quot;,
  ],
  &quot;name&quot;: &quot;A String&quot;, # Identifier. Unique name of the configuration. The name can have one of the following forms: - For project-level configurations: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` - For organization-level configurations: `organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`
  &quot;network&quot;: &quot;A String&quot;, # Traffic will be logged from VMs, VPN tunnels and Interconnect Attachments within the network. Format: projects/{project_id}/global/networks/{name}
  &quot;state&quot;: &quot;A String&quot;, # Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Setting state=DISABLED will pause the log generation for this config.
  &quot;subnet&quot;: &quot;A String&quot;, # Traffic will be logged from VMs within the subnetwork. Format: projects/{project_id}/regions/{region}/subnetworks/{name}
  &quot;targetResourceState&quot;: &quot;A String&quot;, # Output only. Describes the state of the configured target resource for diagnostic purposes.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the config was updated.
  &quot;vpnTunnel&quot;: &quot;A String&quot;, # Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name}
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists all `VpcFlowLogsConfigs` in a given project.

Args:
  parent: string, Required. The parent resource of the VpcFlowLogsConfig, in one of the following formats: - For project-level resourcs: `projects/{project_id}/locations/global` - For organization-level resources: `organizations/{organization_id}/locations/global` (required)
  filter: string, Optional. Lists the `VpcFlowLogsConfigs` that match the filter expression. A filter expression must use the supported [CEL logic operators] (https://cloud.google.com/vpc/docs/about-flow-logs-records#supported_cel_logic_operators).
  orderBy: string, Optional. Field to use to sort the list.
  pageSize: integer, Optional. Number of `VpcFlowLogsConfigs` to return.
  pageToken: string, Optional. Page token from an earlier query, as returned in `next_page_token`.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for the `ListVpcFlowLogsConfigs` method.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Page token to fetch the next set of configurations.
  &quot;unreachable&quot;: [ # Locations that could not be reached (when querying all locations with `-`).
    &quot;A String&quot;,
  ],
  &quot;vpcFlowLogsConfigs&quot;: [ # List of VPC Flow Log configurations.
    { # A configuration to generate VPC Flow Logs.
      &quot;aggregationInterval&quot;: &quot;A String&quot;, # Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the config was created.
      &quot;crossProjectMetadata&quot;: &quot;A String&quot;, # Optional. Determines whether to include cross project annotations in the logs. This field is available only for organization configurations. If not specified in org configs will be set to CROSS_PROJECT_METADATA_ENABLED.
      &quot;description&quot;: &quot;A String&quot;, # Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.
      &quot;filterExpr&quot;: &quot;A String&quot;, # Optional. Export filter used to define which VPC Flow Logs should be logged.
      &quot;flowSampling&quot;: 3.14, # Optional. The value of the field must be in (0, 1]. The sampling rate of VPC Flow Logs where 1.0 means all collected logs are reported. Setting the sampling rate to 0.0 is not allowed. If you want to disable VPC Flow Logs, use the state field instead. Default value is 1.0.
      &quot;interconnectAttachment&quot;: &quot;A String&quot;, # Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/regions/{region}/interconnectAttachments/{name}
      &quot;labels&quot;: { # Optional. Resource labels to represent user-provided metadata.
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;metadata&quot;: &quot;A String&quot;, # Optional. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default value is INCLUDE_ALL_METADATA.
      &quot;metadataFields&quot;: [ # Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if &quot;metadata&quot; was set to CUSTOM_METADATA.
        &quot;A String&quot;,
      ],
      &quot;name&quot;: &quot;A String&quot;, # Identifier. Unique name of the configuration. The name can have one of the following forms: - For project-level configurations: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` - For organization-level configurations: `organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`
      &quot;network&quot;: &quot;A String&quot;, # Traffic will be logged from VMs, VPN tunnels and Interconnect Attachments within the network. Format: projects/{project_id}/global/networks/{name}
      &quot;state&quot;: &quot;A String&quot;, # Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Setting state=DISABLED will pause the log generation for this config.
      &quot;subnet&quot;: &quot;A String&quot;, # Traffic will be logged from VMs within the subnetwork. Format: projects/{project_id}/regions/{region}/subnetworks/{name}
      &quot;targetResourceState&quot;: &quot;A String&quot;, # Output only. Describes the state of the configured target resource for diagnostic purposes.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the config was updated.
      &quot;vpnTunnel&quot;: &quot;A String&quot;, # Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name}
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates an existing `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Updating a configuration with `state=DISABLED` will fail. 2. The following fields are not considered as settings for the purpose of the check mentioned above, therefore - updating another configuration with the same fields but different values for the following fields will fail as well: * name * create_time * update_time * labels * description

Args:
  name: string, Identifier. Unique name of the configuration. The name can have one of the following forms: - For project-level configurations: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` - For organization-level configurations: `organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` (required)
  body: object, The request body.
    The object takes the form of:

{ # A configuration to generate VPC Flow Logs.
  &quot;aggregationInterval&quot;: &quot;A String&quot;, # Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the config was created.
  &quot;crossProjectMetadata&quot;: &quot;A String&quot;, # Optional. Determines whether to include cross project annotations in the logs. This field is available only for organization configurations. If not specified in org configs will be set to CROSS_PROJECT_METADATA_ENABLED.
  &quot;description&quot;: &quot;A String&quot;, # Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.
  &quot;filterExpr&quot;: &quot;A String&quot;, # Optional. Export filter used to define which VPC Flow Logs should be logged.
  &quot;flowSampling&quot;: 3.14, # Optional. The value of the field must be in (0, 1]. The sampling rate of VPC Flow Logs where 1.0 means all collected logs are reported. Setting the sampling rate to 0.0 is not allowed. If you want to disable VPC Flow Logs, use the state field instead. Default value is 1.0.
  &quot;interconnectAttachment&quot;: &quot;A String&quot;, # Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/regions/{region}/interconnectAttachments/{name}
  &quot;labels&quot;: { # Optional. Resource labels to represent user-provided metadata.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;metadata&quot;: &quot;A String&quot;, # Optional. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default value is INCLUDE_ALL_METADATA.
  &quot;metadataFields&quot;: [ # Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if &quot;metadata&quot; was set to CUSTOM_METADATA.
    &quot;A String&quot;,
  ],
  &quot;name&quot;: &quot;A String&quot;, # Identifier. Unique name of the configuration. The name can have one of the following forms: - For project-level configurations: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` - For organization-level configurations: `organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`
  &quot;network&quot;: &quot;A String&quot;, # Traffic will be logged from VMs, VPN tunnels and Interconnect Attachments within the network. Format: projects/{project_id}/global/networks/{name}
  &quot;state&quot;: &quot;A String&quot;, # Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Setting state=DISABLED will pause the log generation for this config.
  &quot;subnet&quot;: &quot;A String&quot;, # Traffic will be logged from VMs within the subnetwork. Format: projects/{project_id}/regions/{region}/subnetworks/{name}
  &quot;targetResourceState&quot;: &quot;A String&quot;, # Output only. Describes the state of the configured target resource for diagnostic purposes.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the config was updated.
  &quot;vpnTunnel&quot;: &quot;A String&quot;, # Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name}
}

  updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field. For example, to change the state of the configuration to ENABLED, specify `update_mask` = `&quot;state&quot;`, and the `vpc_flow_logs_config` would be: `vpc_flow_logs_config = { name = &quot;projects/my-project/locations/global/vpcFlowLogsConfigs/my-config&quot; state = &quot;ENABLED&quot; }`
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="queryOrgVpcFlowLogsConfigs">queryOrgVpcFlowLogsConfigs(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>QueryOrgVpcFlowLogsConfigs returns a list of all organization-level VPC Flow Logs configurations applicable to the specified project.

Args:
  parent: string, Required. The parent resource of the VpcFlowLogsConfig, specified in the following format: `projects/{project_id}/locations/global` (required)
  filter: string, Optional. Lists the `VpcFlowLogsConfigs` that match the filter expression. A filter expression must use the supported [CEL logic operators] (https://cloud.google.com/vpc/docs/about-flow-logs-records#supported_cel_logic_operators).
  pageSize: integer, Optional. Number of `VpcFlowLogsConfigs` to return.
  pageToken: string, Optional. Page token from an earlier query, as returned in `next_page_token`.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for the `QueryVpcFlowLogsConfigs` method.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Page token to fetch the next set of configurations.
  &quot;unreachable&quot;: [ # Locations that could not be reached (when querying all locations with `-`).
    &quot;A String&quot;,
  ],
  &quot;vpcFlowLogsConfigs&quot;: [ # List of VPC Flow Log configurations.
    { # A configuration to generate VPC Flow Logs.
      &quot;aggregationInterval&quot;: &quot;A String&quot;, # Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the config was created.
      &quot;crossProjectMetadata&quot;: &quot;A String&quot;, # Optional. Determines whether to include cross project annotations in the logs. This field is available only for organization configurations. If not specified in org configs will be set to CROSS_PROJECT_METADATA_ENABLED.
      &quot;description&quot;: &quot;A String&quot;, # Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.
      &quot;filterExpr&quot;: &quot;A String&quot;, # Optional. Export filter used to define which VPC Flow Logs should be logged.
      &quot;flowSampling&quot;: 3.14, # Optional. The value of the field must be in (0, 1]. The sampling rate of VPC Flow Logs where 1.0 means all collected logs are reported. Setting the sampling rate to 0.0 is not allowed. If you want to disable VPC Flow Logs, use the state field instead. Default value is 1.0.
      &quot;interconnectAttachment&quot;: &quot;A String&quot;, # Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/regions/{region}/interconnectAttachments/{name}
      &quot;labels&quot;: { # Optional. Resource labels to represent user-provided metadata.
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;metadata&quot;: &quot;A String&quot;, # Optional. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default value is INCLUDE_ALL_METADATA.
      &quot;metadataFields&quot;: [ # Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if &quot;metadata&quot; was set to CUSTOM_METADATA.
        &quot;A String&quot;,
      ],
      &quot;name&quot;: &quot;A String&quot;, # Identifier. Unique name of the configuration. The name can have one of the following forms: - For project-level configurations: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` - For organization-level configurations: `organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`
      &quot;network&quot;: &quot;A String&quot;, # Traffic will be logged from VMs, VPN tunnels and Interconnect Attachments within the network. Format: projects/{project_id}/global/networks/{name}
      &quot;state&quot;: &quot;A String&quot;, # Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Setting state=DISABLED will pause the log generation for this config.
      &quot;subnet&quot;: &quot;A String&quot;, # Traffic will be logged from VMs within the subnetwork. Format: projects/{project_id}/regions/{region}/subnetworks/{name}
      &quot;targetResourceState&quot;: &quot;A String&quot;, # Output only. Describes the state of the configured target resource for diagnostic purposes.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the config was updated.
      &quot;vpnTunnel&quot;: &quot;A String&quot;, # Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name}
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="queryOrgVpcFlowLogsConfigs_next">queryOrgVpcFlowLogsConfigs_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="showEffectiveFlowLogsConfigs">showEffectiveFlowLogsConfigs(parent, filter=None, pageSize=None, pageToken=None, resource=None, x__xgafv=None)</code>
  <pre>ShowEffectiveFlowLogsConfigs returns a list of all VPC Flow Logs configurations applicable to a specified resource.

Args:
  parent: string, Required. The parent resource of the VpcFlowLogsConfig, specified in the following format: `projects/{project_id}/locations/global` (required)
  filter: string, Optional. Lists the `EffectiveVpcFlowLogsConfigs` that match the filter expression. A filter expression must use the supported [CEL logic operators] (https://cloud.google.com/vpc/docs/about-flow-logs-records#supported_cel_logic_operators).
  pageSize: integer, Optional. Number of `EffectiveVpcFlowLogsConfigs` to return. Default is 30.
  pageToken: string, Optional. Page token from an earlier query, as returned in `next_page_token`.
  resource: string, Required. The resource to get the effective VPC Flow Logs configuration for. The resource must belong to the same project as the parent. The resource must be a network, subnetwork, interconnect attachment, VPN tunnel, or a project.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for the `ShowEffectiveFlowLogsConfigs` method.
  &quot;effectiveFlowLogsConfigs&quot;: [ # List of Effective Vpc Flow Logs configurations.
    { # A configuration to generate a response for GetEffectiveVpcFlowLogsConfig request.
      &quot;aggregationInterval&quot;: &quot;A String&quot;, # The aggregation interval for the logs. Default value is INTERVAL_5_SEC.
      &quot;crossProjectMetadata&quot;: &quot;A String&quot;, # Determines whether to include cross project annotations in the logs. This field is available only for organization configurations. If not specified in org configs will be set to CROSS_PROJECT_METADATA_ENABLED.
      &quot;filterExpr&quot;: &quot;A String&quot;, # Export filter used to define which VPC Flow Logs should be logged.
      &quot;flowSampling&quot;: 3.14, # The value of the field must be in (0, 1]. The sampling rate of VPC Flow Logs where 1.0 means all collected logs are reported. Setting the sampling rate to 0.0 is not allowed. If you want to disable VPC Flow Logs, use the state field instead. Default value is 1.0.
      &quot;interconnectAttachment&quot;: &quot;A String&quot;, # Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/regions/{region}/interconnectAttachments/{name}
      &quot;metadata&quot;: &quot;A String&quot;, # Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default value is INCLUDE_ALL_METADATA.
      &quot;metadataFields&quot;: [ # Custom metadata fields to include in the reported VPC flow logs. Can only be specified if &quot;metadata&quot; was set to CUSTOM_METADATA.
        &quot;A String&quot;,
      ],
      &quot;name&quot;: &quot;A String&quot;, # Unique name of the configuration. The name can have one of the following forms: - For project-level configurations: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` - For organization-level configurations: `organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` - For a Compute config, the name will be the path of the subnet: `projects/{project_id}/regions/{region}/subnetworks/{subnet_id}`
      &quot;network&quot;: &quot;A String&quot;, # Traffic will be logged from VMs, VPN tunnels and Interconnect Attachments within the network. Format: projects/{project_id}/global/networks/{name}
      &quot;scope&quot;: &quot;A String&quot;, # Specifies the scope of the config (e.g., SUBNET, NETWORK, ORGANIZATION..).
      &quot;state&quot;: &quot;A String&quot;, # The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Setting state=DISABLED will pause the log generation for this config.
      &quot;subnet&quot;: &quot;A String&quot;, # Traffic will be logged from VMs within the subnetwork. Format: projects/{project_id}/regions/{region}/subnetworks/{name}
      &quot;vpnTunnel&quot;: &quot;A String&quot;, # Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name}
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Page token to fetch the next set of configurations.
  &quot;unreachable&quot;: [ # Locations that could not be reached (when querying all locations with `-`).
    &quot;A String&quot;,
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="showEffectiveFlowLogsConfigs_next">showEffectiveFlowLogsConfigs_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

</body></html>